IRIX Base Documentation 1998 November

home *** CD-ROM | disk | FTP | other *** search

/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / p_man / cat3 / Xm / MrmOpenHierarchyPerDisplay.z / MrmOpenHierarchyPerDisplay

Wrap

Text File | 1998-10-30 | 19KB | 265 lines

MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyyPPPPeeeerrrrDDDDiiiissssppppllllaaaayyyy((((UUUU3333NNNNXXXXIIII))))XXXX SSSSyyyysssstttteeeeMMMMmmmmrrrrmmmmVVVVOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyyPPPPeeeerrrrDDDDiiiissssppppllllaaaayyyy((((3333XXXX)))) NNNNAAAAMMMMEEEE MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyyPPPPeeeerrrrDDDDiiiissssppppllllaaaayyyy - Allocates a hierarchy ID and opens all the UID files in the hierarchy SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS #include <Mrm/MrmPublic.h> CCCCaaaarrrrddddiiiinnnnaaaallll MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyyPPPPeeeerrrrDDDDiiiissssppppllllaaaayyyy( DDDDiiiissssppppllllaaaayyyy ****ddddiiiissssppppllllaaaayyyy, MMMMrrrrmmmmCCCCoooouuuunnnntttt nnnnuuuummmm____ffffiiiilllleeeessss, SSSSttttrrrriiiinnnngggg ffffiiiilllleeee____nnnnaaaammmmeeeessss____lllliiiisssstttt[], MMMMrrrrmmmmOOOOssssOOOOppppeeeennnnPPPPaaaarrrraaaammmmPPPPttttrrrr ****aaaannnncccciiiillllllllaaaarrrryyyy____ssssttttrrrruuuuccccttttuuuurrrreeeessss____lllliiiisssstttt, MMMMrrrrmmmmHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy ****hhhhiiiieeeerrrraaaarrrrcccchhhhyyyy____iiiidddd); VVVVEEEERRRRSSSSIIIIOOOONNNN This page documents Motif 2.1. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyyPPPPeeeerrrrDDDDiiiissssppppllllaaaayyyy allows you to specify the list of UID files that MRM searches in subsequent fetch operations. All subsequent fetch operations return the first occurrence of the named item encountered while traversing the UID hierarchy from the first list element (UID file specification) to the last list element. This function also allocates a hierarchy ID and opens all the UID files in the hierarchy. It initializes the optimized search lists in the hierarchy. If MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyyPPPPeeeerrrrDDDDiiiissssppppllllaaaayyyyencounters any errors during its execution, any files that were opened are closed. The application must call XXXXttttAAAAppppppppIIIInnnniiiittttiiiiaaaalllliiiizzzzeeee before calling MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyyPPPPeeeerrrrDDDDiiiissssppppllllaaaayyyy. _d_i_s_p_l_a_y Specifies the connection to the X server and the value to pass to XXXXttttRRRReeeessssoooollllvvvveeeePPPPaaaatttthhhhnnnnaaaammmmeeee. For more information on the DDDDiiiissssppppllllaaaayyyystructure, see the Xlib function XXXXOOOOppppeeeennnnDDDDiiiissssppppllllaaaayyyy. _n_u_m__f_i_l_e_s Specifies the number of files in the name list. _f_i_l_e__n_a_m_e_s__l_i_s_t Specifies an array of character strings that identify the UID files. _a_n_c_i_l_l_a_r_y__s_t_r_u_c_t_u_r_e_s__l_i_s_t A list of operating-system-dependent ancillary structures corresponding to items such as filenames, clobber flags, and so forth. This argument should be NULL for most operations. If you need to reference this structure, see the definition of MMMMrrrrmmmmOOOOssssOOOOppppeeeennnnPPPPaaaarrrraaaammmmPPPPttttrrrrin the MMMMrrrrmmmmPPPPuuuubbbblllliiiicccc....hhhh header file for more information. Page 1 (printed 10/24/98) MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyyPPPPeeeerrrrDDDDiiiissssppppllllaaaayyyy((((UUUU3333NNNNXXXXIIII))))XXXX SSSSyyyysssstttteeeeMMMMmmmmrrrrmmmmVVVVOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyyPPPPeeeerrrrDDDDiiiissssppppllllaaaayyyy((((3333XXXX)))) _h_i_e_r_a_r_c_h_y__i_d Returns the search hierarchy ID. The search hierarchy ID identifies the list of UID files that MRM searches (in order) when performing subsequent fetch calls. Each UID file string in _f_i_l_e__n_a_m_e_s__l_i_s_t can specify either a full pathname or a filename. If a UID file string has a leading / (slash), it specifies a full pathname, and MRM opens the file as specified. Otherwise, the UID file string specifies a filename. In this case MRM looks for the file along a search path specified by the UUUUIIIIDDDDPPPPAAAATTTTHHHH environment variable or by a default search path, which varies depending on whether or not the XXXXAAAAPPPPPPPPLLLLRRRREEEESSSSDDDDIIIIRRRR environment variable is set. The UUUUIIIIDDDDPPPPAAAATTTTHHHH environment variable specifies a search path and naming conventions associated with UID files. It can contain the substitution field %%%%UUUU, where the UID file string from the _f_i_l_e__n_a_m_e_s__l_i_s_t argument to MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyyPPPPeeeerrrrDDDDiiiissssppppllllaaaayyyy is substituted for %%%%UUUU. It can also contain the substitution fields accepted by XXXXttttRRRReeeessssoooollllvvvveeeePPPPaaaatttthhhhnnnnaaaammmmeeee. The substitution field %%%%TTTT is always mapped to _u_i_d. The entire path is searched first with %%%%SSSS mapped to ....uuuuiiiidddd. If no file is found, it is searched again with %%%%SSSS mapped to NULL. For example, the following UUUUIIIIDDDDPPPPAAAATTTTHHHH value and MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyyPPPPeeeerrrrDDDDiiiissssppppllllaaaayyyy call cause MRM to open two separate UID files: UIDPATH=/uidlib/%L/%U.uid:/uidlib/%U/%L static char *uid_files[] = {"/usr/users/me/test.uid", "test2"}; MrmHierarchy *Hierarchy_id; MrmOpenHierarchyPerDisplay((MrmCount)2,uid_files, NULL, Hierarchy_id) MRM opens the first file, ////uuuussssrrrr////uuuusssseeeerrrrssss////mmmmeeee////tttteeeesssstttt....uuuuiiiidddd, as specified in the _f_i_l_e__n_a_m_e_s__l_i_s_t argument to MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyyPPPPeeeerrrrDDDDiiiissssppppllllaaaayyyy, because the UID file string in the _f_i_l_e__n_a_m_e_s__l_i_s_t argument specifies a full pathname. MRM looks for the second file, tttteeeesssstttt2222, first as ////uuuuiiiiddddlllliiiibbbb////%%%%LLLL////tttteeeesssstttt2222....uuuuiiiiddddand second as ////uuuuiiiiddddlllliiiibbbb////tttteeeesssstttt2222////%%%%LLLL, where the display's language string is substituted for %%%%LLLL. After MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyyPPPPeeeerrrrDDDDiiiissssppppllllaaaayyyyopens the UID hierarchy, you should not delete or modify the UID files until you close the UID hierarchy by calling MMMMrrrrmmmmCCCClllloooosssseeeeHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy. If UUUUIIIIDDDDPPPPAAAATTTTHHHH is not set, but the environment variable XXXXAAAAPPPPPPPPLLLLRRRREEEESSSSDDDDIIIIRRRR is set, MRM searches the following pathnames: +o %%%%UUUU%%%%SSSS +o $$$$XXXXAAAAPPPPPPPPLLLLRRRREEEESSSSDDDDIIIIRRRR////%%%%LLLL////uuuuiiiidddd////%%%%NNNN////%%%%UUUU%%%%SSSS Page 2 (printed 10/24/98) MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyyPPPPeeeerrrrDDDDiiiissssppppllllaaaayyyy((((UUUU3333NNNNXXXXIIII))))XXXX SSSSyyyysssstttteeeeMMMMmmmmrrrrmmmmVVVVOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyyPPPPeeeerrrrDDDDiiiissssppppllllaaaayyyy((((3333XXXX)))) +o $$$$XXXXAAAAPPPPPPPPLLLLRRRREEEESSSSDDDDIIIIRRRR////%%%%llll////uuuuiiiidddd////%%%%NNNN////%%%%UUUU%%%%SSSS +o $$$$XXXXAAAAPPPPPPPPLLLLRRRREEEESSSSDDDDIIIIRRRR////uuuuiiiidddd////%%%%NNNN////%%%%UUUU%%%%SSSS +o $$$$XXXXAAAAPPPPPPPPLLLLRRRREEEESSSSDDDDIIIIRRRR////%%%%LLLL////uuuuiiiidddd////%%%%UUUU%%%%SSSS +o $$$$XXXXAAAAPPPPPPPPLLLLRRRREEEESSSSDDDDIIIIRRRR////%%%%llll////uuuuiiiidddd////%%%%UUUU%%%%SSSS +o $$$$XXXXAAAAPPPPPPPPLLLLRRRREEEESSSSDDDDIIIIRRRR////uuuuiiiidddd////%%%%UUUU%%%%SSSS +o $$$$HHHHOOOOMMMMEEEE////uuuuiiiidddd////%%%%UUUU%%%%SSSS +o $$$$HHHHOOOOMMMMEEEE////%%%%UUUU%%%%SSSS +o ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////%%%%LLLL////uuuuiiiidddd////%%%%NNNN////%%%%UUUU%%%%SSSS +o ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////%%%%llll////uuuuiiiidddd////%%%%NNNN////%%%%UUUU%%%%SSSS +o ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////uuuuiiiidddd////%%%%NNNN////%%%%UUUU%%%%SSSS +o ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////%%%%LLLL////uuuuiiiidddd////%%%%UUUU%%%%SSSS +o ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////%%%%llll////uuuuiiiidddd////%%%%UUUU%%%%SSSS +o ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////uuuuiiiidddd////%%%%UUUU%%%%SSSS +o ////uuuussssrrrr////iiiinnnncccclllluuuuddddeeee////XXXX11111111////uuuuiiiidddd////%%%%UUUU%%%%SSSS If neither UUUUIIIIDDDDPPPPAAAATTTTHHHH nor XXXXAAAAPPPPPPPPLLLLRRRREEEESSSSDDDDIIIIRRRR is set, MRM searches the following pathnames: +o %%%%UUUU%%%%SSSS +o $$$$HHHHOOOOMMMMEEEE////%%%%LLLL////uuuuiiiidddd////%%%%NNNN////%%%%UUUU%%%%SSSS +o $$$$HHHHOOOOMMMMEEEE////%%%%llll////uuuuiiiidddd////%%%%NNNN////%%%%UUUU%%%%SSSS +o $$$$HHHHOOOOMMMMEEEE////uuuuiiiidddd////%%%%NNNN////%%%%UUUU%%%%SSSS +o $$$$HHHHOOOOMMMMEEEE////%%%%LLLL////uuuuiiiidddd////%%%%UUUU%%%%SSSS +o $$$$HHHHOOOOMMMMEEEE////%%%%llll////uuuuiiiidddd////%%%%UUUU%%%%SSSS +o $$$$HHHHOOOOMMMMEEEE////uuuuiiiidddd////%%%%UUUU%%%%SSSS +o $$$$HHHHOOOOMMMMEEEE////%%%%UUUU%%%%SSSS +o ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////%%%%LLLL////uuuuiiiidddd////%%%%NNNN////%%%%UUUU%%%%SSSS +o ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////%%%%llll////uuuuiiiidddd////%%%%NNNN////%%%%UUUU%%%%SSSS +o ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////uuuuiiiidddd////%%%%NNNN////%%%%UUUU%%%%SSSS Page 3 (printed 10/24/98) MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyyPPPPeeeerrrrDDDDiiiissssppppllllaaaayyyy((((UUUU3333NNNNXXXXIIII))))XXXX SSSSyyyysssstttteeeeMMMMmmmmrrrrmmmmVVVVOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyyPPPPeeeerrrrDDDDiiiissssppppllllaaaayyyy((((3333XXXX)))) +o ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////%%%%LLLL////uuuuiiiidddd////%%%%UUUU%%%%SSSS +o ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////%%%%llll////uuuuiiiidddd////%%%%UUUU%%%%SSSS +o ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////uuuuiiiidddd////%%%%UUUU%%%%SSSS +o ////uuuussssrrrr////iiiinnnncccclllluuuuddddeeee////XXXX11111111////uuuuiiiidddd////%%%%UUUU%%%%SSSS These paths are defaults that vendors may change. For example, a vendor may use different directories for ////uuuussssrrrr////lllliiiibbbb////XXXX11111111 and ////uuuussssrrrr////iiiinnnncccclllluuuuddddeeee////XXXX11111111. The following substitutions are used in these paths: %%%%UUUU The UID file string, from the _f_i_l_e__n_a_m_e_s__l_i_s_t argument. %%%%NNNN The class name of the application. %%%%LLLL The display's language string. This string is influenced by XXXXttttSSSSeeeettttLLLLaaaannnngggguuuuaaaaggggeeeePPPPrrrroooocccc. The default string is determined by calling setlocale(_L_C__A_L_L, _N_U_L_L). %%%%llll The language component of the display's language string. %%%%SSSS The suffix to the filename. The entire path is first searched with a suffix of ....uuuuiiiidddd. If no file is found, it is searched again with a NULL suffix. RRRREEEETTTTUUUURRRRNNNN This function returns one of the following status return constants: MMMMrrrrmmmmSSSSUUUUCCCCCCCCEEEESSSSSSSS The function executed successfully. MMMMrrrrmmmmNNNNOOOOTTTT____FFFFOOOOUUUUNNNNDDDD File not found. MMMMrrrrmmmmFFFFAAAAIIIILLLLUUUURRRREEEE The function failed. RRRREEEELLLLAAAATTTTEEEEDDDD MMMMrrrrmmmmCCCClllloooosssseeeeHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy(3). Page 4 (printed 10/24/98)